docs: fix broken toctree, refresh API reference, and clean up references#680
Merged
Conversation
HiGHS prints a banner + progress lines to the Python REPL on every m.solve() call by default. In a tutorial that calls solve many times, this drowns the actual lesson in solver chatter. Pass output_flag=False (a HiGHS solver option forwarded via **solver_options) to suppress it. Touches the four notebooks where solver_name="highs" is the only solver invoked: - create-a-model.ipynb - create-a-model-with-coordinates.ipynb - manipulating-models.ipynb (9 solves) - transport-tutorial.ipynb Left alone: - infeasible-model.ipynb (uses Gurobi, kwarg is OutputFlag there; also showing solver feedback may be pedagogically relevant for infeasibility detection). - solve-on-remote.ipynb / solve-on-oetc.ipynb (remote handler manages its own logging). - piecewise-*.ipynb (already addressed in #677). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Extends the log-silencing scope to the two piecewise tutorials, which together call m.solve() nine times. Same transformation as the other notebooks — output_flag=False as a HiGHS-specific kwarg forwarded via **solver_options. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…-logs # Conflicts: # examples/piecewise-inequality-bounds.ipynb # examples/piecewise-linear-constraints.ipynb
- Add doc/coordinate-alignment.nblink so the index.rst toctree entry resolves to examples/coordinate-alignment.ipynb. - Update api.rst to match the current public API: add the missing solver classes (COPT, Knitro, MindOpt, PIPS, cuPDLPx), expose top-level helpers (align, merge, options, EvolvingAPIWarning, PerformanceWarning), add the missing Model methods (add_sos_constraints, reformulate_sos_constraints, compute_infeasibilities, format_infeasibilities), add Variable methods (to_linexpr, fix/unfix, relax/unrelax), add sections for QuadraticExpression, Objective, and RemoteHandler, remove the duplicate Variables.integers, and fix the "hook" -> "hood" typo. - contributing.rst: replace stale Black reference with ruff, correct the nblink example (proper JSON, right path, fixed RST indentation that was breaking pygments), and use pre-commit run --all-files. - benchmark.rst: fix the rendered objective, which read as a product of two variables; corrected to the actual linear benchmark (2x + y with x - y >= i-1, matching benchmark_linopy.py). - prerequisites.rst: add SCIP, give MOSEK a description, drop the dangling "-" after MindOpt, remove the outdated HiGHS-platforms claim, and clarify what the [solvers] extra actually pulls in. - conf.py + index.rst: bump copyright to 2026 and fix the "contnuous" typo on the landing page. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Collaborator
|
@FBumann coordinate alignment is definitely wanted in the docs. can have a look at the pr later today |
Collaborator
Author
|
There is a folow up that does the heavy lifting here: #681 |
FabianHofmann
approved these changes
May 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
A docs cleanup pass covering correctness issues found during a thorough review:
index.rstlistedcoordinate-alignmentbut no.rst/.nblinkexisted; addeddoc/coordinate-alignment.nblinkpointing to the existing example notebook.api.rst):COPT,Knitro,MindOpt,PIPS,cuPDLPx.align,merge,options,EvolvingAPIWarning,PerformanceWarning.add_sos_constraints,reformulate_sos_constraints,compute_infeasibilities,format_infeasibilities) and Variable methods (to_linexpr,fix/unfix,relax/unrelax).QuadraticExpression,Objective, andRemoteHandler.Variables.integersentry; fixed"under the hook"→"under the hood".contributing.rst— replaced the stale Black reference with ruff, corrected the.nblinkexample (proper JSON, right path, indentation that was breaking pygments), and usedpre-commit run --all-files.benchmark.rst— rendered objective read as a product of two variables (nonlinear); fixed to the actual linear benchmark2x + ywithx − y ≥ i−1, verified againstbenchmark/scripts/benchmark_linopy.py.prerequisites.rst— added SCIP, gave MOSEK a description, removed dangling" -"after MindOpt, dropped the outdated HiGHS-platforms claim, and clarified whatlinopy[solvers]actually pulls in (verified againstpyproject.toml).conf.py+index.rst— bumped copyright to 2026, fixed"contnuous"typo.Also bundled (already on the branch): silencing HiGHS console output in the tutorial notebooks.
Test plan
sphinx-build -b html doc /tmp/outruns clean for the changed files (no new warnings introduced).Top-level helpers,QuadraticExpression,Objective,Remote solving, and the additional solver pages).coordinate-alignmentshows up in the rendered toctree.🤖 Generated with Claude Code
@FabianHofmann Did you mean to not include the
coordinate-alignmentnotebook in the docs? Happy to remove it until we finish Arithmetics milestone